Skip to main content

Get Patient Details

Purpose​

The Get Patient Details endpoint uses the SOAP API to prefill information in the Basic Info form. Prefilling data helps streamline the patient update process, ensuring that known details are automatically populated to minimize manual entry. However, it is important to note that not all fields in the Basic Info form are returned by this endpoint.

Fields Returned by Get Patient Endpoint​

Field Name
ID
Age
DOB
City
State
Suffix
Prefix
Country
ZipCode
Gender
LastName
FirstName
WorkPhone
MiddleName
WorkPhoneExt
AddressLine1
AddressLine2
MaritalStatus
Adjustments
AlertMessage
EmailAddress
EmergencyName
EmergencyPhone
GuarantorDifferentThanPatient
GuarantorFirstName
GuarantorLastName
GuarantorMiddleName
GuarantorPrefix
GuarantorSuffix
HomePhone
HomePhoneExt
MobilePhone
MobilePhoneExt
EmergencyPhoneExt
AlertShowWhenDisplayingPatientDetailse
AlertShowWhenEnteringEncounters
AlertShowWhenPostingPayments
AlertShowWhenPreparingPatientStatements
AlertShowWhenSchedulingAppointments
AlertShowWhenViewingClaimDetails
Charges
CreatedDate
DefaultRenderingProviderFullName
DefaultRenderingProviderId
DefaultServiceLocationBillingName
DefaultServiceLocationFaxPhone
DefaultServiceLocationFaxPhoneExt
DefaultServiceLocationId
DefaultServiceLocationName
DefaultServiceLocationNameAddressLine1
DefaultServiceLocationNameAddressLine2
DefaultServiceLocationNameCity
DefaultServiceLocationNameCountry
DefaultServiceLocationNameState
DefaultServiceLocationNameZipCode
DefaultServiceLocationPhone
DefaultServiceLocationPhoneExt
EmployerName
EmploymentStatus
InsuranceBalance
InsurancePayments
LastAppointmentDate
LastDiagnosis
LastEncounterDate
LastModifiedDate
LastPaymentDate
LastStatementDate
MedicalRecordNumber
MostRecentNote1Date
MostRecentNote1Message
MostRecentNote1User
EmergencyPhoneExt
MostRecentNote2Date
MostRecentNote2Message
MostRecentNote2User
MostRecentNote3Date
MostRecentNote3Message
MostRecentNote3User
MostRecentNote4Date
MostRecentNote4Message
MostRecentNote4User
PatientBalance
PatientFullName
PatientPayments
PracticeId
PracticeName
PrimaryCarePhysicianFullName
PrimaryCarePhysicianId
ReferralSource
ReferringProviderFullName
ReferringProviderId
SSN
StatementNote
TotalBalance

Fields Left Out (Not Prefilled)​

Field Name
Primary Phone Type
Gender Identity
Race
Emergency Phone Type
Emergency Contact Email Address
Relationship to Emergency Contact
Relationship to Responsible Party
Responsible Party Phone Type
Responsible Party Address Line 1
Responsible Party Address Line 2
Responsible Party Phone Type
Responsible Party Email Address
Relationship Party City
Relationship Party State
Relationship Party Zip Code
Relationship Party Phone Number

Deduced Fields from Get Patient Endpoint​

Some fields in the Basic Info form are not directly returned by the Get Patient Details endpoint but can be inferred from the available data:

  1. Responsible Party:​

This field has three options - Myself, Emergency Contact, and Other. Since Tebra only returns Myself and Other, we deduce Emergency Contact by comparing names:

  • If the emergencyContact's firstName, lastName, or middleName matches with responsibleParty's corresponding names, assign Emergency Contact.
  • If they don't match, default to Myself or Other as applicable.

  1. Emergency Contact Name::​

The full name is extracted from the EmergencyName field:

  • If the name is in the format "Jane Doe", it is split into:
    • First Name: Jane
    • Last Name: Doe
  • If the name follows the format "Jane Doe Smith", it is split into:
    • First Name: Jane
    • Last Name: Doe
    • Last Name: Smith

API Request Format​

API Endpoint​

GET /v1/GetPatient

Request Payload Example:​

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pat="url/GetPatient">
   <soapenv:Header/>
   <soapenv:Body>
      <pat:GetPatientDetails>
         <pat:PatientID>123456</pat:PatientID>
         <pat:PatientExternalID>123</pat:PatientExternalID>
      </pat:GetPatientDetails>
   </soapenv:Body>
</soapenv:Envelope>

Response Example​

{
    "AddressLine1": {},
    "AddressLine2": {},
    "Adjustments": {},
    "Age": "24",
    "AlertMessage": {},
    "AlertShowWhenDisplayingPatientDetails": "False",
    "AlertShowWhenEnteringEncounters": "False",
    "AlertShowWhenPostingPayments": "False",
    "AlertShowWhenPreparingPatientStatements": "False",
    "AlertShowWhenSchedulingAppointments": "False",
    "AlertShowWhenViewingClaimDetails": "False",
    "Cases": {
        "PatientCaseData": {
            "ConditionRelatedToAbuse": "False",
            "ConditionRelatedToAutoAccident": "False",
            "ConditionRelatedToAutoAccidentState": {},
            "ConditionRelatedToEPSDT": {},
            "ConditionRelatedToEmergency": "False",
            "ConditionRelatedToEmployment": "False",
            "ConditionRelatedToFamilyPlanning": "False",
            "ConditionRelatedToOther": "False",
            "ConditionRelatedToPregnancy": "False",
            "DatesAccidentDate": {},
            "DatesAcuteManifestationDate": {},
            "DatesInjuryEndDate": {},
            "DatesInjuryStartDate": {},
            "DatesLastMenstrualPeriodDate": {},
            "DatesLastSeenDate": {},
            "DatesLastXRayDate": {},
            "DatesReferralDate": {},
            "DatesRelatedDisabilityEndDate": {},
            "DatesRelatedDisabilityStartDate": {},
            "DatesRelatedHospitalizationEndDate": {},
            "DatesRelatedHospitalizationStartDate": {},
            "DatesSameOrSimilarIllnessEndDate": {},
            "DatesSameOrSimilarIllnessStartDate": {},
            "DatesUnableToWorkEndDate": {},
            "DatesUnableToWorkStartDate": {},
            "Description": {},
            "Name": "Default Case",
            "PatientCaseID": "81258",
            "PayerScenario": "Commercial",
            "ReferringProviderFullName": {},
            "ReferringProviderID": {},
            "SendPatientStatements": "1"
        }
    },
    "Charges": {},
    "City": {},
    "CollectionCategoryName": "Current                                                                                                                                                                                                 ",
    "Country": "United States of America",
    "CreatedDate": "10/2/2024 9:37:06 AM",
    "DOB": "11/21/2000",
    "DefaultRenderingProviderFullName": {},
    "DefaultRenderingProviderId": {},
    "DefaultServiceLocationBillingName": {},
    "DefaultServiceLocationFaxPhone": {},
    "DefaultServiceLocationFaxPhoneExt": {},
    "DefaultServiceLocationId": {},
    "DefaultServiceLocationName": {},
    "DefaultServiceLocationNameAddressLine1": {},
    "DefaultServiceLocationNameAddressLine2": {},
    "DefaultServiceLocationNameCity": {},
    "DefaultServiceLocationNameCountry": {},
    "DefaultServiceLocationNameState": {},
    "DefaultServiceLocationNameZipCode": {},
    "DefaultServiceLocationPhone": {},
    "DefaultServiceLocationPhoneExt": {},
    "EmailAddress": "test@agmail.com",
    "EmergencyName": "Drill Florida Lane",
    "EmergencyPhone": "1234567890",
    "EmergencyPhoneExt": {},
    "EmployerName": {},
    "EmploymentStatus": "Unknown",
    "FirstName": "Janet",
    "Gender": "F",
    "GuarantorDifferentThanPatient": "True",
    "GuarantorFirstName": "JANE",
    "GuarantorLastName": "DOE",
    "GuarantorMiddleName": "FLORIDA",
    "GuarantorPrefix": {},
    "GuarantorSuffix": {},
    "HomePhone": {},
    "HomePhoneExt": {},
    "ID": "1900",
    "InsuranceBalance": {},
    "InsurancePayments": {},
    "LastAppointmentDate": "2/24/2025 9:20:00 AM",
    "LastDiagnosis": {},
    "LastEncounterDate": {},
    "LastModifiedDate": "2/24/2025 9:21:18 AM",
    "LastName": "Ronaldo",
    "LastPaymentDate": {},
    "LastStatementDate": {},
    "MaritalStatus": "S",
    "MedicalRecordNumber": {},
    "MiddleName": "Sarah",
    "MobilePhone": "(814) 248-8999",
    "MobilePhoneExt": {},
    "MostRecentNote1Date": {},
    "MostRecentNote1Message": {},
    "MostRecentNote1User": {},
    "MostRecentNote2Date": {},
    "MostRecentNote2Message": {},
    "MostRecentNote2User": {},
    "MostRecentNote3Date": {},
    "MostRecentNote3Message": {},
    "MostRecentNote3User": {},
    "MostRecentNote4Date": {},
    "MostRecentNote4Message": {},
    "MostRecentNote4User": {},
    "PatientBalance": {},
    "PatientFullName": "Janet Sarah Ronaldo",
    "PatientPayments": {},
    "PracticeId": "2",
    "PracticeName": "Sandbox",
    "Prefix": "Mr.",
    "PrimaryCarePhysicianFullName": {},
    "PrimaryCarePhysicianId": {},
    "ReferralSource": {},
    "ReferringProviderFullName": {},
    "ReferringProviderId": {},
    "SSN": {},
    "State": {},
    "StatementNote": {},
    "Suffix": {},
    "TotalBalance": {},
    "WorkPhone": {},
    "WorkPhoneExt": {},
    "ZipCode": "89898"
}